This endpoint is currently in beta. Errors may happen. Changes may occur.
Returns detailed information about a specific tariff and its component structure. This endpoint provides essential tariff details for understanding the tariff’s organizational context and component types.
Key Features:
valid_at
(shows only valid components)has_time_of_use
: Indicates if Time-of-Use pricing applieshas_tiers
: Indicates if tiered pricing applieshas_eligibilities
: Indicates if the tariff has eligibility requirements at any levelis_active
: Indicates if tariff/component is currently activeunit
: Shows the required unit format for component values (standardized for all component types)input_key
: Provides guidance on input key naming based on component prezio_codetou_levels
: Lists TOU level IDs that apply to any component (not just DEMAND components)tou_levels
: Complete TOU structure with explicit day/time rangesperiods
: Array of time periods, each with its own summary and from_day/to_day and from_time/to_timeUse Cases:
Note: This endpoint provides the necessary information to construct requests for the /calculate/advanced endpoint. Use the unit
, input_key
, and tou_levels
fields to properly structure your calculation requests.
Token-based authentication with required prefix "Token"
A unique integer value identifying this Tariff.
Filter components to show only those valid at the specified datetime. Format: 'YYYY-MM-DD HH:MM:SS'. If not provided, shows components valid at current time.
[BETA] Detailed tariff information with enhanced component structure for /calculate/advanced integration
Enhanced serializer for detailed tariff retrieval using common mixins